3D Graphics Programming with QuickDraw 3D 1.5.4

Managing View Plane Cameras

QuickDraw 3D provides routines that you can use to create and edit view plane cameras.

Q3ViewPlaneCamera_New

You can use the Q3ViewPlaneCamera_New function to create a new view plane camera.



 
TQ3CameraObject Q3ViewPlaneCamera_New (

                     const TQ3ViewPlaneCameraData *cameraData);

cameraData: A pointer to a view plane camera data structure.

DESCRIPTION

The Q3ViewPlaneCamera_New function returns, as its function result, a new view plane camera having the camera characteristics specified by the cameraData parameter.

Q3ViewPlaneCamera_GetData

You can use the Q3ViewPlaneCamera_GetData function to get the data that defines a view plane camera.



 
TQ3Status Q3ViewPlaneCamera_GetData (

                     TQ3CameraObject camera, 

                     TQ3ViewPlaneCameraData *cameraData);

camera: A view plane camera object.
cameraData: On exit, a pointer to a view plane camera data structure.

DESCRIPTION

The Q3ViewPlaneCamera_GetData function returns, through the cameraData parameter, information about the view plane camera specified by the camera parameter. See "View Plane Camera Data Structure" for the structure of a view plane camera data structure.

Q3ViewPlaneCamera_SetData

You can use the Q3ViewPlaneCamera_SetData function to set the data that defines a view plane camera.



 
TQ3Status Q3ViewPlaneCamera_SetData (

                     TQ3CameraObject camera, 

                     const TQ3ViewPlaneCameraData *cameraData);

camera: A view plane camera object.
cameraData: A pointer to a view plane camera data structure.

DESCRIPTION

The Q3ViewPlaneCamera_SetData function sets the data associated with the view plane camera specified by the camera parameter to the data specified by the cameraData parameter.

Q3ViewPlaneCamera_GetViewPlane

You can use the Q3ViewPlaneCamera_GetViewPlane function to get the current distance of the view plane from a view plane camera.



 
TQ3Status Q3ViewPlaneCamera_GetViewPlane (

                     TQ3CameraObject camera, 

                     float *viewPlane);

camera: A view plane camera object.
viewPlane: On exit, the distance of the view plane from the specified camera.

DESCRIPTION

The Q3ViewPlaneCamera_GetViewPlane function returns, in the viewPlane parameter, the distance of the view plane from the camera specified by the camera parameter.

Q3ViewPlaneCamera_SetViewPlane

You can use the Q3ViewPlaneCamera_SetViewPlane function to set the distance of the view plane from a view plane camera.



 
TQ3Status Q3ViewPlaneCamera_SetViewPlane (

                     TQ3CameraObject camera, 

                     float viewPlane);

camera: A view plane camera object.
viewPlane: The desired distance of the view plane from the specified camera.

DESCRIPTION

The Q3ViewPlaneCamera_SetViewPlane function sets the distance from the camera specified by the camera parameter to its view plane to the value specified in the viewPlane parameter.

Q3ViewPlaneCamera_GetHalfWidth

You can use the Q3ViewPlaneCamera_GetHalfWidth function to get the half-width of the object specifying a view plane camera.



 
TQ3Status Q3ViewPlaneCamera_GetHalfWidth (

                     TQ3CameraObject camera, 

                     float *halfWidthAtViewPlane);

camera: A view plane camera object.
halfWidthAtViewPlane: On exit, the half-width of the cross section of the viewed object.

DESCRIPTION

The Q3ViewPlaneCamera_GetHalfWidth function returns, in the halfWidthAtViewPlane parameter, the half-width of the cross section of the viewed object of the camera specified by the camera parameter.

Q3ViewPlaneCamera_SetHalfWidth

You can use the Q3ViewPlaneCamera_SetHalfWidth function to set the half-width of the object specifying a view plane camera.



 
TQ3Status Q3ViewPlaneCamera_SetHalfWidth (

                     TQ3CameraObject camera, 

                     float halfWidthAtViewPlane);

camera: A view plane camera object.
halfWidthAtViewPlane: The desired half-width of the cross section of the viewed object of the specified camera.

DESCRIPTION

The Q3ViewPlaneCamera_SetHalfWidth function sets the half-width of the cross section of the viewed object of the camera specified by the camera parameter to the value specified in the halfWidthAtViewPlane parameter.

Q3ViewPlaneCamera_GetHalfHeight

You can use the Q3ViewPlaneCamera_GetHalfHeight function to get the half-height of the object specifying a view plane camera.



 
TQ3Status Q3ViewPlaneCamera_GetHalfHeight (

                     TQ3CameraObject camera, 

                     float *halfHeightAtViewPlane);

camera: A view plane camera object.
halfHeightAtViewPlane: On exit, the half-height of the cross section of the viewed object.

DESCRIPTION

The Q3ViewPlaneCamera_GetHalfHeight function returns, in the halfHeightAtViewPlane parameter, the half-height of the cross section of the viewed object of the camera specified by the camera parameter.

Q3ViewPlaneCamera_SetHalfHeight

You can use the Q3ViewPlaneCamera_SetHalfHeight function to set the half-height of the object specifying a view plane camera.



 
TQ3Status Q3ViewPlaneCamera_SetHalfHeight (

                     TQ3CameraObject camera, 

                     float halfHeightAtViewPlane);

camera: A view plane camera object.
halfHeightAtViewPlane: The desired half-height of the cross section of the viewed object.

DESCRIPTION

The Q3ViewPlaneCamera_SetHalfHeight function sets the half-height of the cross section of the viewed object of the camera specified by the camera parameter to the value specified in the halfHeightAtViewPlane parameter.

Q3ViewPlaneCamera_GetCenterX

You can use the Q3ViewPlaneCamera_GetCenterX function to get the horizontal center of the viewed object.



 
TQ3Status Q3ViewPlaneCamera_GetCenterX (

                     TQ3CameraObject camera, 

                     float *centerXOnViewPlane);

camera: A view plane camera object.
centerXOnViewPlane: On exit, the x coordinate of the center of the viewed object.

DESCRIPTION

The Q3ViewPlaneCamera_GetCenterX function returns, in the centerXOnViewPlane parameter, the x coordinate of the center of the viewed object of the camera specified by the camera parameter.

Q3ViewPlaneCamera_SetCenterX

You can use the Q3ViewPlaneCamera_SetCenterX function to set the horizontal center of the viewed object.



 
TQ3Status Q3ViewPlaneCamera_SetCenterX (

                     TQ3CameraObject camera, 

                     float centerXOnViewPlane);

camera: A view plane camera object.
centerXOnViewPlane: The desired x coordinate of the center of the viewed object.

DESCRIPTION

The Q3ViewPlaneCamera_SetCenterX function sets the x coordinate of the center of the viewed object of the camera specified by the camera parameter to the value specified in the centerXOnViewPlane parameter.

Q3ViewPlaneCamera_GetCenterY

You can use the Q3ViewPlaneCamera_GetCenterY function to get the vertical center of the viewed object.



 
TQ3Status Q3ViewPlaneCamera_GetCenterY (

                     TQ3CameraObject camera, 

                     float *centerYOnViewPlane);

camera: A view plane camera object.
centerYOnViewPlane: On exit, the y coordinate of the center of the viewed object.

DESCRIPTION

The Q3ViewPlaneCamera_GetCenterY function returns, in the centerYOnViewPlane parameter, the y coordinate of the center of the viewed object of the camera specified by the camera parameter.

Q3ViewPlaneCamera_SetCenterY

You can use the Q3ViewPlaneCamera_SetCenterY function to set the vertical center of the viewed object.



 
TQ3Status Q3ViewPlaneCamera_SetCenterY (

                     TQ3CameraObject camera, 

                     float centerYOnViewPlane);

camera: A view plane camera object.
centerYOnViewPlane: The desired y coordinate of the center of the viewed object.

DESCRIPTION

The Q3ViewPlaneCamera_SetCenterY function sets the y coordinate of the center of the viewed object of the camera specified by the camera parameter to the value specified in the centerYOnViewPlane parameter.